IBM Endpoint Manager Inspectors Reference

Terminology

Win: Windows
Lin: Red Hat and SUSE Linux
Sol: SUN Solaris
HPUX: Hewlett-Packard UNIX version
AIX: IBM AIX
Mac: Apple Macintosh
Ubu: Ubuntu/Debian
WM: Windows Mobile

The version (e.g. Lin:8.1) corresponds to the version of the IEM product (8.1) in which the inspector was introduced in the client on that platform.
The version number is not shown if it is less than 8.0.


Platform


Contents

Action Objects
Authorization Objects
Client Objects
Directory Services
Environment Objects
Filesystem Objects
Firewall Objects
Fixlet Objects
Formatting Objects
Installed System Software
bundle
capability
debian base package
debian package upstream version
debian package upstream version with multiplicity
debian package version
debian package version epoch
debian package version epoch with multiplicity
debian package version revision
debian package version revision with multiplicity
debian package version with multiplicity
debian versioned package
debianpackagecache
debianpkg dependency
debianpkg reverse dependencies
debianpkg verfile
debianpkg version
object_repository
package
patch
pkgdb
pkginfo
product
rpm package release
rpm package release with multiplicity
rpm package version
rpm package version record
rpm package version record with multiplicity
rpm package version with multiplicity
rpmdatabase
short rpm package version record
short rpm package version record with multiplicity
software_depot
Introspectors
License Objects
Microsoft IIS Metabase Objects
Miscellaneous
Networking Objects
Power Objects
Primitive Objects
Registry Objects
Session Objects
Session Statistics
Site Objects
SMBIOS objects
System Objects
Task Objects
User Objects
Windows Mobile Device Objects
WMI Objects
World Objects

IBM Endpoint Manager wiki

Installed System Software

These Inspectors help you manage system objects and software packages.

rpmdatabase

The <rpmdatabase> objects are the Linux RPM Package Manager Inspectors. The RPM database contains entries for all the installed programs on this computer.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

package

This filesystem object can inspect the propeties of an RPM (RPM Package Manager) package. Each package contains information about the program, including name and version.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

capability

A package can have capabilities that it requires, provides, obsoletes, or conflicts with. For instance, apache may require sh, and provide httpd. If you want to install apache, you will need to have sh in the RPM database. If you want to install a package that uses httpd, you will need to install apache.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

rpm package release

The <rpm package release> Inspectors disclose properties of the RPM package version record Inspector. They are collected from the 'Release' component of the Epoch, Version and Release fields associated with an RPM package. The behavior of this inspector differs from a string, because they are sorted according to RPM rules defined by the rpmvercmp() function of the RPM library. Don't create an <rpm package release> inspector with embedded '-' or whitespace characters. These characters are disallowed in RPM, and will cause the statement to fail. Note: Requires the presence of the RPM library and librpminfo (an open source library created by BigFix containing modified RPM library code) on the client machine. librpminfo is installed on the client as part of the normal BES client RPM installation procedure.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

rpm package release with multiplicity

The <rpm package release with multiplicity> Inspectors deal with arrays of RPM package releases, allowing you to extract unique releases and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

rpm package version

The <rpm package version> Inspectors disclose properties of the RPM package version record Inspector. They are collected from the 'Version' component of the Epoch, Version and Release fields associated with an RPM package. The behavior of this inspector differs from a string, because they are sorted according to RPM rules defined by the rpmvercmp() function of the RPM library. Don't create an <rpm package release> inspector with embedded '-' or whitespace characters. These characters are disallowed in RPM, and will cause the statement to fail. Note: Requires the presence of the RPM library and librpminfo (an open source library created by BigFix containing modified RPM library code) on the client machine. librpminfo is installed on the client as part of the normal BES client RPM installation procedure.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

rpm package version with multiplicity

The <rpm package version with multiplicity> Inspectors deal with arrays of RPM package versions, allowing you to extract unique versions and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

rpm package version record

The <rpm package version record> Inspectors provide version-related information, such as Epoch, Version and Release, for an RPM package. Inspectors of this type are sorted according to an RPM-specific ordering mechanism defined by the rpmVersionCompare() function of the RPM library.Note: Requires the presence of the RPM library and librpminfo (an open source library created by BigFix containing modified RPM library code) on the client machine. librpminfo is installed on the client as part of the normal BES client RPM installation procedure.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

rpm package version record with multiplicity

The <rpm package version record with multiplicity> Inspectors deal with arrays of RPM package version records, allowing you to extract unique records and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

short rpm package version record

This is the same as an RPM package version record, except that the epoch (if one exists) is not shown when converted to a string. However, even though it isn't displayed, the epoch is still retained. If you need to remove the epoch, use one of the 'no epoch' Inspectors.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

short rpm package version record with multiplicity

The <short rpm package version record with multiplicity> Inspectors deal with arrays of short RPM package version records, allowing you to extract unique records and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

pkgdb

This is a database object created by BigFix to keep track of all the Solaris packages (pkginfos) that have been installed on this computer. The pkginfo object, in turn, contains Solaris patches, each with an ID and a revision number. The database essentially contains a comprehensive list of patches, allowing you to directly access a patch without going through pkginfo. The syntax is "patch of pkgdb", which can greatly simplify your relevance expressions.

Creation Methods

DeclarationDescriptionPlatforms (?)
pkgdbA top-level object containing a list of all the installed packages, in the form of pkginfos.Sol

Properties

DeclarationReturn typeDescriptionPlatforms (?)
patch <string> of <pkgdb><patch>

Plural: patches
Returns the requested patch from the package database. Typically used for existence tests.Sol
patch id <string> of <pkgdb><string>

Plural: patch ids
Returns the specified patch id string from the package database. Typically used for existence tests.Sol
patch id of <pkgdb><string>

Plural: patch ids
Returns a space-delimited list of patch ids from the specified package database.Sol
patch of <pkgdb><patch>

Plural: patches
Returns all the patches listed in the given pkgdb (package database).Sol
pkginfo <string> of <pkgdb><pkginfo>

Plural: pkginfos
Returns the specified pkginfo from the package database. Typically used for existence tests.Sol
pkginfo of <pkgdb><pkginfo>

Plural: pkginfos
Returns all the packages (as pkginfos) in the given package database.Sol

pkginfo

Pkginfo is an object containing information about Solaris packages, which are used to deliver patches. Pkginfo contains information about the category, the intended architecture, vendors, patch IDs and revision numbers. Other package information can be inspected using the "param" property which lets you access other parameters by name.

Creation Methods

DeclarationDescriptionPlatforms (?)
pkginfo <string> of <pkgdb>Returns the specified pkginfo from the package database. Typically used for existence tests.

Example:
exists pkginfo "SUNWrdm" of pkgdb - Returns TRUE if the specified pkginfo exists in the package database.
Sol
pkginfo of <pkgdb>Returns all the packages (as pkginfos) in the given package database.Sol

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<pkginfo> as string<string>Converts a pkginfo object into a string.Sol
arch of <pkginfo><string>

Plural: archs
Returns a string representing the architecture of the package specified by the pkginfo object.Sol
category of <pkginfo><string>

Plural: categories
Returns a string representing the category of the package specified by pkginfo.Sol
name of <pkginfo><string>

Plural: names
Returns the name of the package from the specified pkginfo object.Sol
param <string> of <pkginfo><string>

Plural: params
Returns the value of the named parameter (specified by <string>) from the pkginfo object.Sol
patch <string> of <pkginfo><patch>

Plural: patches
Returns a named patch from the specified pkginfo.Sol
patch id <string> of <pkginfo><string>

Plural: patch ids
Returns the specified patch id string from the specified pkginfo of the package database. Typically used for existence tests.Sol
patch id of <pkginfo><string>

Plural: patch ids
Returns a space delimited list of patch ids, for example: "123456-01 123456-02 200213-23 501234-02". This is the same list available from the PATCHLIST parameter of the pkginfo.Sol
patch of <pkginfo><patch>

Plural: patches
Returns the patch object referenced in the pkginfo object.Sol
pkginst of <pkginfo><string>

Plural: pkginsts
Returns a short string used as an abbreviation for the package name given by the pkginfo object. Typically contains a vendor symbol and an ID, like "CSCOh007".Sol
vendor of <pkginfo><string>

Plural: vendors
Returns a string containing the name of the package vendor. This is the same as the VENDOR parameter of the pkginfo.Sol
version of <pkginfo><string>

Plural: versions
Returns a version number for the specified pkginfo object. Not to be confused with revision numbers of patches. This is the same as the VERSION parameter of the pkginfo.Sol

patch

An object that exposes the properties of a Solaris patch, each of which has a base ID followed by a revision number, such as 123456-12. Here the base is 123456, which identifies the patch, and 12, which represents the revision of this particular patch.

Creation Methods

DeclarationDescriptionPlatforms (?)
patch <string> of <pkgdb>Returns the requested patch from the package database. Typically used for existence tests.

Example:
exists patch "123456" of pkgdb - Returns TRUE if any revision of the patch with this ID exists in the package database.

Example:
exists patch "123456-12" of pkgdb - Returns TRUE if this exact patch ID (including the revision) exists in the package database.
Sol
patch of <pkgdb>Returns all the patches listed in the given pkgdb (package database).Sol
patch <string> of <pkginfo>Returns a named patch from the specified pkginfo.

Example:
exists patch "123456" of pkginfo "SUNWrdm" of pkgdb - Returns TRUE if this patch exists in the specified pkginfo of the package database.
Sol
patch of <pkginfo>Returns the patch object referenced in the pkginfo object.Sol

Properties

DeclarationReturn typeDescriptionPlatforms (?)
base of <patch><string>

Plural: bases
Returns the base number of the given patch, which is a unique identifier for the file, as a string.Sol
greatest revision of <patch><string>

Plural: greatest revisions
Returns the highest revision of the patch.Sol
least revision of <patch><string>

Plural: least revisions
Returns the lowest revision of the patch.Sol
revision <string> of <patch><string>

Plural: revisions
Returns the specified revision string from the given patch. Typically used for existence tests.Sol
revision of <patch><string>

Plural: revisions
Returns an additional revision number which modifies the base of the patch.Sol

bundle

On HPUX platforms, a bundle object is derived from a product type and used to inspect software installations as managed by the Software Depot. On Macintosh platforms, a bundle refers to a core foundation folder hierarchy derived from CFBundle.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

product

The <product> object contains properties (such as vendor and revision) of the associated software product. On AIX, products are installed into an Object Repository.On HPUX products are installed in the Software Depot.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

object_repository

A database corresponding to installable software products on AIX computers.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

software_depot

Software Depot uses the swlist INDEX to identify the collection of products installed on the HPUX machine.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debian base package

For Tivoli Inspectors, a Debian package is considered to include both the package and the version. This allows the Inspectors to home in on specific versioned packages and not just the package itself, which may have numerous versions. The base package Inspectors help to tease these two aspects apart, stripping the version info and returning a list of the packages by name only.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debian package upstream version with multiplicity

The <debian package upstream version with multiplicity> Inspectors deal with arrays of Debian packages, allowing you to extract unique upstream_versions and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debian package upstream version

The upstream_version of a Debian package is the main version number. Along with the epoch and revision, it is one of the components of the Debian versioning scheme.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debian package version epoch with multiplicity

The <debian package version epoch with multiplicity> Inspectors deal with arrays of Debian packages, allowing you to extract unique version 'epochs' and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debian package version epoch

The <debian package version epoch> Inspectors deal with the 'epoch' component of a Debian package version. The epoch is an unsigned integer, typically a small number. If it is omitted, zero is the default. It allows the package provider to create a fresh start with version numbering schemes.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debian package version revision with multiplicity

The <debian package version revision with multiplicity> Inspectors deal with arrays of Debian package allowing you to extract unique version revisions and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debian package version revision

Also known as the 'debian_revision', these Inspectors reveal the revision of a Debian package based on the upstream_version. The revision component of the version is optional. Typically, the revision is set to 1 whenever the upstream_version is increased.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debian package version with multiplicity

The <debian package version with multiplicity> Inspectors deal with arrays of Debian packages, allowing you to extract unique versions and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debian package version

For Tivoli Inspectors, a Debian package is considered to include both the package and the version. This allows the Inspectors to home in on specific versioned packages and not just the package itself, which may have numerous versions. These version Inspectors return just the version(s) of a given Debian package. A version is composed of three parts: an epoch, an upstream_version and a debian_revision.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debian versioned package

The <debian versioned package> Inspectors return all the versions of the Debian package that are available for the base package.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debianpackagecache

The <debianpackagecache> Inspectors refer to the cache directory set up for Debian packages.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debianpkg dependency

A package may depend on the previous installation of other software packages. The <debianpkg dependency> Inspectors detail those dependencies. A Debian package may replace another package, conflict with it or depend on it. For more information, see the Debian.org site.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debianpkg reverse dependencies

Debian packages often depend on other packages, with you can find by looking in the given package. You can reverse the situation and instead use the Advanced Packageing Tool (APT) to discover which programs are dependent on a given package. These Inspectors allow you to find these reverse dependencies.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debianpkg verfile

The pkg Inspectors deal with base packages, i.e., packages stripped of their version information. This set of Inspectors lists the names of the APT system files that describe the package in question. If you edit and search the files that result from this inspector, you can find descriptive information about the specified packages.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

debianpkg version

The pkg Inspectors deal with base packages, i.e., packages stripped of their version information. This set of Inspectors deals with the versions corresponding to the given package(s).

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)